vcProgram

A program containing routines

See in: Overview

Module: vcExecutor2

Parent: -

Children: vcRobotProgram

Referenced by: vcCallProgramStatement.TargetProgramReference, vcProgramManager.Programs, vcProgramManager.copyProgram(), vcProgramManager.createProgram(), ... (see more)

vcCallProgramStatement.TargetProgramReference
vcProgramManager.Programs
vcProgramManager.copyProgram()
vcProgramManager.createProgram()
vcProgramManager.findProgram()
vcRoutine.Program

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Description	String	RW	Gets or sets a description for the program.
IsDynamic	Boolean	R	Gets whether the program was created during simulation or not.
Name	String	RW	Gets or sets the name for the program.
ProgramManager	vcProgramManager	R	Gets the vcExecutor2.vcProgramManager
Properties	vcPropertyContainer	R	Gets the properties of the program.
Routines	vcList[vcRoutine]	R	Gets a list of contained routines
Status	vcProgramStatus	R	Gets the current vcExecutor2.vcProgramStatus.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
createRoutine	vcRoutine	Optional Keyword[name = String]	Creates a new routine. See more Parameters: Optional: name (str): Name for the new routine. Returns: vcProgram: The new routine. Exceptions: ValueError: When the routine name is reserved.
delete	None	None	" Deletes the program. See more Parameters: None Returns: None Exceptions: ValueError: When attempting to delete a non-dynamic program while the simulation is running.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnRoutineAdded	vcRoutine program	Triggered when a routine is added to the program. Parameters: program (vcExecutor2.vcRoutine): Added routine instance.
OnRoutineRemoving	vcRoutine routine	Triggered when a routine is about to be deleted from the program. Parameters: routine (vcExecutor2.vcRoutine): Deleted routine instance.
OnStatusChanged	vcProgram program, vcProgramStatus status	Triggered when the program status has changed. See more Parameters: program (vcExecutor2.vcProgram): Subject program. status (vcExecutor2.vcProgramStatus): New status.